Direct Integration API
Party Employment
Sample Request
{
"Package": {
"Content": {
"Application": {
"PersonApplicant": [
{
"Employment": [{
"PAYE": {
"Income": {
"@GrossRegularOvertimeAmount": 100000,
"@GrossRegularOvertimeFrequency": "Yearly",
"@GrossSalaryAmount": 100000,
"@GrossSalaryFrequency": "Fortnightly",
"@BonusAmount": 100000,
"@BonusFrequency": "Monthly",
"@CommissionAmount": 100000,
"@CommissionFrequency": "Weekly",
"@CarAllowanceAmount": 100000,
"@CarAllowanceFrequency": "Yearly",
"@WorkAllowanceAmount": 100000,
"@WorkAllowanceFrequency": "Fortnightly",
"@WorkersCompensationAmount": 100000,
"@WorkersCompensationFrequency": "Monthly"
},
"@UniqueID": "ef78a2351b1a",
"@Status": "Primary",
"@Basis": "Full Time",
"@StartDate": "2024-03-31",
"@EndDate": "2001-02-23",
"@Occupation": "Software Engineer",
"@ANZSCOOccupationCode": "111111",
"@OnProbation": "Yes",
"@x_Employer": "uPAYEemployer",
"@Industry": "PAYE Industry"
}
}],
"CreditHistory": {
"@UniqueID": "be5c41728adb"
},
"Privacy": {
"@AllowDirectMarketing": "No",
"@AllowThirdPartyDisclosure": "Yes",
"@PrivacyActConsentSigned": "Yes",
"@AllowCreditCheck": "Yes",
"@DateSigned": "2022-03-31"
},
"ProofOfIdentity": [
{
"@DOBVerified": "No",
"@DateOfIssue": "2024-02-07",
"@DocumentCategory": "Photographic",
"@DocumentNumber": "123456",
"@DocumentType": "National Identity Card",
"@NameOnDocument": "etsts",
"@NameVerified": "No",
"@Original": "No",
"@PhotographVerified": "No",
"@PlaceOfIssue": "test",
"@ResidentialAddressVerified": "No",
"@SequenceNumber": "0",
"@UniqueID": "bc63e7c48b29"
}
],
"ResponsibleLending": {
"Mitigant": {
"@UniqueID": "d0a07d30e83d"
},
"SignificantChange": {
"@UniqueID": "c7dc1f42933b"
},
"@AnticipatedChanges": "No"
},
"Contact": {
"@PreferredContact": "Work Phone",
"EmailAddress": {
"@Email": "email@email.com",
"@UniqueID": "e1e4f56db027"
},
"WorkPhone": {
"@CountryCode": "64",
"@NewZealandDialingCode": "01",
"@Number": "22"
},
"CurrentAddress": {
"@HousingStatus": "Own Home",
"@StartDate": "2020-03-31",
"@x_MailingAddress": "d7c56ad47d43",
"@x_ResidentialAddress": "d7c56ad47d43"
},
"PostSettlementAddress": {
"@HousingStatus": "Own Home",
"@x_MailingAddress": "d7c56ad47d43",
"@x_ResidentialAddress": "d7c56ad47d43"
}
},
"PersonName": {
"@NameTitle": "Mr",
"@FirstName": "Ian",
"@Surname": "Abbott"
},
"MaritalStatusDetails": {
"@x_Spouse": "uSpouse"
},
"NominatedBorrower": {
"@x_Nominee": "uCompanyCP"
},
"PowerOfAttorney": {
"@Type": "Enduring",
"@x_POAHolder": "uPOAHolder"
},
"@DateOfBirth": "1957-09-12",
"@ResidencyStatus": "Non Resident",
"@MaritalStatus": "Married",
"@x_Household": "fa86c8054f4c",
"@UniqueID": "bbcc2a6dde95",
"@ApplicantType": "Borrower",
"@PrimaryApplicant": "Yes",
"@PrincipalForeignResidence": "NZ",
"@JointNomination": "Yes",
"@POAGranted": "Yes",
"@x_Solicitor": "uSolicitor"
},
{
"Employment": [{
"SelfEmployed": {
"BusinessIncomePrevious": {
"@StartDate": "2021-04-01",
"@EndDate": "2022-03-31",
"@ProfitBeforeTax": 100000.4,
"@x_Accountant": "uAccountant",
"Addback": {
"@Allowances": 1.1,
"@AmortisationOfGoodwill": 2.2,
"@Bonus": 3.3,
"@CarExpense": 4.4,
"@CarryForwardLosses": 5.5,
"@Depreciation": 6.6,
"@HomeOffice": 7.7,
"@Interest": 8.8,
"@Lease": 9.9,
"@NonCashBenefits": 10.10,
"@NonRecurringExpenses": 11.11,
"@Salary": 12.12
}
},
"BusinessIncomePrior": {
"@StartDate": "2021-04-01",
"@EndDate": "2022-03-31",
"@ProfitBeforeTax": 100000.3,
"@x_Accountant": "uAccountant",
"Addback": {
"@Allowances": 1.1,
"@AmortisationOfGoodwill": 2.2,
"@Bonus": 3.3,
"@CarExpense": 4.4,
"@CarryForwardLosses": 5.5,
"@Depreciation": 6.6,
"@HomeOffice": 7.7,
"@Interest": 8.8,
"@Lease": 9.9,
"@NonCashBenefits": 10.10,
"@NonRecurringExpenses": 11.11,
"@Salary": 12.12
}
},
"BusinessIncomeRecent": {
"@StartDate": "2021-04-01",
"@EndDate": "2022-03-31",
"@ProfitBeforeTax": 100000.2,
"@x_Accountant": "uAccountant",
"Addback": {
"@Allowances": 1.1,
"@AmortisationOfGoodwill": 2.2,
"@Bonus": 3.3,
"@CarExpense": 4.4,
"@CarryForwardLosses": 5.5,
"@Depreciation": 6.6,
"@HomeOffice": 7.7,
"@Interest": 8.8,
"@Lease": 9.9,
"@NonCashBenefits": 10.10,
"@NonRecurringExpenses": 11.11,
"@Salary": 12.12
}
},
"BusinessIncomeYearToDate": {
"@StartDate": "2021-04-01",
"@ProfitBeforeTax": 100000.1,
"@x_Accountant": "uAccountant",
"Addback": {
"@Allowances": 1.1,
"@AmortisationOfGoodwill": 2.2,
"@Bonus": 3.3,
"@CarExpense": 4.4,
"@CarryForwardLosses": 5.5,
"@Depreciation": 6.6,
"@HomeOffice": 7.7,
"@Interest": 8.8,
"@Lease": 9.9,
"@NonCashBenefits": 10.10,
"@NonRecurringExpenses": 11.11,
"@Salary": 12.12
}
},
"@DeclaredIncome": {
"@StartDate": "",
"@EndDate": "",
"@ProfitBeforeTax": ""
},
"@UniqueID": "uPersonApplicant",
"@Status": "Primary",
"@Basis": "Full Time",
"@StartDate": "2022-03-31",
"@EndDate": "2024-03-31",
"@Occupation": "Product Owner",
"@ANZSCOOccupationCode": "521111",
"@x_Employer": "uBusinessDetails",
"@Industry": "SelfEmployed Industry",
"@x_Accountant": "uAccountant"
}
}],
"Contact": {
"CurrentAddress": {
"@HousingStatus": "Renting",
"@StartDate": "2020-03-31",
"@x_MailingAddress": "ec0fb11a9603",
"@x_ResidentialAddress": "ec0fb11a9603"
},
"EmailAddress": {
"@UniqueID": "fc8ba9854751"
},
"HomePhone": {
"@CountryCode": "64",
"@NewZealandDialingCode": "01",
"@Number": "78"
},
"PostSettlementAddress": {
"@HousingStatus": "Renting",
"@x_MailingAddress": "aa15be2d8a76",
"@x_ResidentialAddress": "aa15be2d8a76"
},
"@PreferredContact": "Home Phone"
},
"CreditHistory": {
"@UniqueID": "a90e86a49c68"
},
"PersonName": {
"@FirstName": "test",
"@NameTitle": "Mr",
"@Surname": "self empl"
},
"Privacy": {
"@AllowCreditCheck": "Yes",
"@AllowDirectMarketing": "No",
"@AllowTelemarketing": "No",
"@AllowThirdPartyDisclosure": "Yes",
"@CreditAuthoritySigned": "Yes",
"@DateSigned": "2022-03-31",
"@PrivacyActConsentSigned": "Yes"
},
"ProofOfIdentity": [{
"@DOBVerified": "No",
"@DateOfIssue": "2024-02-07",
"@DocumentCategory": "Photographic",
"@DocumentNumber": "242424",
"@DocumentType": "National Identity Card",
"@NameOnDocument": "esg",
"@NameVerified": "No",
"@Original": "No",
"@PhotographVerified": "No",
"@PlaceOfIssue": "sfs",
"@ResidentialAddressVerified": "No",
"@SequenceNumber": "0",
"@UniqueID": "f1ab50c77845"
}],
"ResponsibleLending": {
"Mitigant": {
"@UniqueID": "mitigantUniqueId"
},
"SignificantChange": {
"@UniqueID": "significantUniqueId"
},
"@AnticipatedChanges": "No"
},
"@ApplicantType": "Guarantor",
"@Citizenship": "NZ",
"@DateOfBirth": "2000-02-01",
"@Gender": "Male",
"@HasPreviousName": "No",
"@IsExistingCustomer": "No",
"@JointNomination": "No",
"@MaritalStatus": "Single",
"@POAGranted": "No",
"@ResidencyStatus": "Permanently in New Zealand",
"@SequenceNumber": "2",
"@UniqueID": "selfEmployedUniqueId",
"@x_Household": "fa86c8054f4c",
"@x_Solicitor": "uSolicitor",
"@PrimaryApplicant": "No"
},
{
"Employment": [{
"NotEmployed": {
"Income": {
"@OtherIncomeAmount": 1.1,
"@OtherIncomeDescription": "OtherIncome",
"@OtherIncomeFrequency": "Yearly",
"@JobseekerSupportAmount": 2.2,
"@JobseekerSupportFrequency": "Monthly",
"@PrivatePensionAmount": 3.3,
"@PrivatePensionFrequency": "Fortnightly",
"@SuperannuationAmount": 4.4,
"@SuperannuationFrequency": "Weekly"
},
"@UniqueID": "c955eef4db26",
"@Status": "Primary",
"@StartDate": "2009-03-31",
"@EndDate": "2010-02-08",
"@HomeDuties": "No",
"@OnBenefits": "No",
"@Student": "No",
"@Retired": "Yes"
}
}],
"Contact": {
"CurrentAddress": {
"@HousingStatus": "Renting",
"@StartDate": "2019-03-31",
"@x_MailingAddress": "ec0fb11a9603",
"@x_ResidentialAddress": "ec0fb11a9603"
},
"EmailAddress": {
"@UniqueID": "fc8ba9854751"
},
"HomePhone": {
"@CountryCode": "64",
"@NewZealandDialingCode": "01",
"@Number": "78"
},
"PostSettlementAddress": {
"@HousingStatus": "Renting",
"@x_MailingAddress": "aa15be2d8a76",
"@x_ResidentialAddress": "aa15be2d8a76"
},
"@PreferredContact": "Home Phone"
},
"CreditHistory": {
"@UniqueID": "a90e86a49c68"
},
"PersonName": {
"@FirstName": "test",
"@NameTitle": "Mr",
"@Surname": "not empl"
},
"Privacy": {
"@AllowCreditCheck": "Yes",
"@AllowDirectMarketing": "No",
"@AllowTelemarketing": "No",
"@AllowThirdPartyDisclosure": "Yes",
"@CreditAuthoritySigned": "Yes",
"@DateSigned": "2022-03-31",
"@PrivacyActConsentSigned": "Yes"
},
"ProofOfIdentity": [{
"@DOBVerified": "No",
"@DateOfIssue": "2024-02-07",
"@DocumentCategory": "Photographic",
"@DocumentNumber": "242424",
"@DocumentType": "National Identity Card",
"@NameOnDocument": "esg",
"@NameVerified": "No",
"@Original": "No",
"@PhotographVerified": "No",
"@PlaceOfIssue": "sfs",
"@ResidentialAddressVerified": "No",
"@SequenceNumber": "0",
"@UniqueID": "f1ab50c77845"
}],
"ResponsibleLending": {
"Mitigant": {
"@UniqueID": "e7874ffe7334"
},
"SignificantChange": {
"@UniqueID": "d44fceb4fc1b"
},
"@AnticipatedChanges": "No"
},
"@ApplicantType": "Guarantor",
"@Citizenship": "NZ",
"@DateOfBirth": "2000-02-01",
"@Gender": "Male",
"@HasPreviousName": "No",
"@IsExistingCustomer": "No",
"@JointNomination": "No",
"@MaritalStatus": "Single",
"@POAGranted": "No",
"@ResidencyStatus": "Permanently in New Zealand",
"@SequenceNumber": "2",
"@UniqueID": "b005c500f8fd",
"@x_Household": "fa86c8054f4c",
"@x_Solicitor": "uSolicitor",
"@PrimaryApplicant": "No"
}
]
}
}
}
}Detailed description of each field:
| Field Name | Description | Type | Path | Required | Enumerations | Note |
|---|---|---|---|---|---|---|
| PersonApplicant | Contains applicant details where the applicant is a person, being either a borrower or a guarantor, and may be acting for a Trust | object | Package.Content.Application.PersonApplicant | |||
| Employment | Contains information about the persons current or previous employment | object | Package.Content.Application.PersonApplicant.Employment | |||
| @UniqueID | System assigned unique identifier | string | Package.Content.Application.PersonApplicant.Employment.UniqueID | Yes | Mandatory if employment exists | |
| employmentType??? | string | |||||
| @Status | The current or previous status of the employment | string | Package.Content.Application.PersonApplicant.Employment.Status | Yes | Previous, Primary, Secondary | |
| @Basis | The applicant should indicate whether the employment type is fulltime, part-time, contract, temporary, casual, commission only or seasonal | string | Package.Content.Application.PersonApplicant.Employment.Basis | Yes | Mandatory only for PayE & Self employed. Not Mandatory for Not employed | |
| @StartDate | The start date indicates when the applicant commenced their employment | date | Package.Content.Application.PersonApplicant.Employment.StartDate | Yes | Mandatory for all employment type | |
| @EndDate | The end date indicates when the applicant finalised their employment | date | Package.Content.Application.PersonApplicant.Employment.EndDate | Yes | Mandatory if status is Previous | |
| @OnProbation | The applicant should indicate whether they are on probation with their current employer | string | Package.Content.Application.PersonApplicant.Employment.OnProbation | Yes | Yes, No | Mandatory if employment type is PAYE |
| @HomeDuties | The applicants should indicate whether they perform home duties | string | Package.Content.Application.PersonApplicant.Employment.HomeDuties | Yes | Yes, No | Mandatory if employment type is Not Employed |
| @OnBenefits | The applicants should indicate whether they are receiving unemployment benefits | string | Package.Content.Application.PersonApplicant.Employment.OnBenefits | Yes | Yes, No | Mandatory if employment type is Not Employed |
| @Student | The applicants should indicate whether they are currently a student | string | Package.Content.Application.PersonApplicant.Employment.Student | Yes | Yes, No | Mandatory if employment type is Not Employed |
| @Retired | The applicants should indicate whether they are retired | string | Package.Content.Application.PersonApplicant.Employment.Retired | Yes | Yes, No | Mandatory if employment type is Not Employed |
| @Occupation | Text description of the person's role or occupation for this employment | string | Package.Content.Application.PersonApplicant.Employment.Occupation | Yes | Mandatory if employment type is PAYE and Self Employed | |
| @ANZSCOOccupationCode | The ANZSCO occupation code specifying the person's role or occupation in this employment. This attribute is restricted to the list of ANZSCO occupation codes published by the ABS on 26/03/2013 that superseded the ASCO Occupation Codes, although the superseded codes still remain in common use | string | Package.Content.Application.PersonApplicant.Employment.ANZSCOOccupationCode | Yes | Mandatory if employment type is PAYE and Self Employed | |
| @OccupationCode | An ABS occupation code specifying the person's role or occupation in this employment. This attribute remains but is likely to be deprecated in the future, with the ANZSCOOccupationCode attribute being restricted to the more recent ANZSCO Occupation Codes published by the ABS on 26/03/2013 | string | Package.Content.Application.PersonApplicant.Employment.OccupationCode | Yes | Mandatory if employment type is PAYE and Self Employed | |
| @Industry | Captures a free text description of the Industry Code | string | Package.Content.Application.PersonApplicant.Employment.Industry | |||
| @x_Employer | The employer details for this instance of employment | string | Package.Content.Application.PersonApplicant.Employment.x_Employer | Yes | Mandatory if Employment Type is PAYE and Self Employed | |
| income??? | string | Package.Content.Application.PersonApplicant.Employment. | ||||
| SelfEmployed | Self-employed refers to people who 'work for themselves' in either wholly owned or part-owned organisations, including when operating as a (paid) Director. The organisation may or may not employ other people | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed | |||
| @x_Accountant | Link to the Applicant's accountant | string | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.x_Accountant | Yes | Mandatory if Self Employed | |
| BusinessIncomePrevious | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Details of the share of the income or income-related amounts in the previous financial year (immediately preceding the most recent full financial year), attributable to this applicant (for year = current year -2) | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious | |||
| @EndDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The end date for the stated income, generally the end of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.EndDate | Yes | Mandatory if Employment type is Self Employed and Profit Before Tax is Business Income Previous | |
| @StartDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The start date for the stated income, generally the start of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.StartDate | Yes | Mandatory if Employment type is Self Employed and Profit Before Tax is Business Income Previous | |
| @ProfitBeforeTax | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Captures the net profit/profit before tax for the specified financial year | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.ProfitBeforeTax | Yes | Mandatory if Employment type is Self Employed then based on the income year type enum at least 1 should be mandatory for profit before tax field | |
| @x_Accountant | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Link to the person's accountant for the full previous financial year. This should be populated when the accountant for the specified period is different to that declared as the current accountant | string | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.x_Accountant | |||
| Addback | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Container element for Previous Business Income Addback | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback | |||
| @Allowances | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Allowances amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.Allowances | |||
| @AmortisationOfGoodwill | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Amortisation Of Goodwill amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.AmortisationOfGoodwill | |||
| @Bonus | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Bonus amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.Bonus | |||
| @CarExpense | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Car expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.CarExpense | |||
| @CarryForwardLosses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Carry Forward Losses amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.CarryForwardLosses | |||
| @Depreciation | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Depreciation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.Depreciation | |||
| @HomeOffice | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Home Office amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.HomeOffice | |||
| @Interest | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Interest amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.Interest | |||
| @Lease | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Lease amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.Lease | |||
| @NonCashBenefits | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-cash benefits amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.NonCashBenefits | |||
| @NonRecurringExpenses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-recurring expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.NonRecurringExpenses | |||
| @Salary | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Salary amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.Salary | |||
| @SuperannuationExcess | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Excess superannuation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.Addback.SuperannuationExcess | |||
| BusinessIncomePrior | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Details of the share of the income or income-related amounts in the prior financial year (two years prior to the most recent full financial year), attributable to this applicant (for year = current year -3) | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior | |||
| @EndDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The end date for the stated income, generally the end of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.EndDate | Yes | Mandatory if Employment type is Self Employed and Profit Before Tax is Prior | |
| @StartDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The start date for the stated income, generally the start of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.StartDate | Yes | Mandatory if Employment type is Self Employed and Profit Before Tax is Prior | |
| @ProfitBeforeTax | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Captures the net profit/profit before tax for the specified financial year | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.ProfitBeforeTax | Yes | If Employment type is Self Employed and based on the income year type enum at least 1 should be mandatory for Profit Before Tax field | |
| @x_Accountant | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Link to the person's accountant for the full prior financial year. This should be populated when the accountant for the specified period is different to that declared as the current accountant | string | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrevious.x_Accountant | |||
| Addback | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Container element for Prior Business Income Addback | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback | |||
| @Allowances | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Allowances amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.Allowances | |||
| @AmortisationOfGoodwill | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Amortisation Of Goodwill amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.AmortisationOfGoodwill | |||
| @Bonus | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Bonus amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.Bonus | |||
| @CarExpense | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Car expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.CarExpense | |||
| @CarryForwardLosses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Carry Forward Losses amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.CarryForwardLosses | |||
| @Depreciation | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Depreciation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.Depreciation | |||
| @HomeOffice | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Home Office amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.HomeOffice | |||
| @Interest | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Interest amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.Interest | |||
| @Lease | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Lease amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.Lease | |||
| @NonCashBenefits | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-cash benefits amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.NonCashBenefits | |||
| @NonRecurringExpenses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-recurring expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.NonRecurringExpenses | |||
| @Salary | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Salary amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.Salary | |||
| @SuperannuationExcess | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Excess superannuation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomePrior.Addback.SuperannuationExcess | |||
| BusinessIncomeRecent | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Details of the share of the income or income-related amounts in the most recent full financial year, attributable to this applicant (year = current year -1) | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent | |||
| @EndDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The end date for the stated income, generally the end of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.EndDate | Yes | Mandatory if Employment type is Self Employed and Profit Before Tax is Recent | |
| @StartDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The start date for the stated income, generally the start of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.StartDate | Yes | Mandatory if Employment type is Self Employed and Profit Before Tax is Recent | |
| @ProfitBeforeTax | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Captures the net profit/profit before tax for the specified financial year | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.ProfitBeforeTax | Yes | Mandatory if Employment type is Self Employed and based on the income year type enum at least 1 should be mandatory for Profit Before Tax field | |
| @x_Accountant | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Link to the person's accountant for the full most recent financial year. This should be populated when the accountant for the specified period is different to that declared as the current accountant | string | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.x_Accountant | |||
| Addback | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Container element for Recent Business Income Addback | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback | |||
| @Allowances | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Allowances amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.Allowances | |||
| @AmortisationOfGoodwill | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Amortisation Of Goodwill amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.AmortisationOfGoodwill | |||
| @Bonus | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Bonus amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.Bonus | |||
| @CarExpense | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Car expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.CarExpense | |||
| @CarryForwardLosses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Carry Forward Losses amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.CarryForwardLosses | |||
| @Depreciation | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Depreciation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.Depreciation | |||
| @HomeOffice | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Home Office amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.HomeOffice | |||
| @Interest | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Interest amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.Interest | |||
| @Lease | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Lease amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.Lease | |||
| @NonCashBenefits | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-cash benefits amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.NonCashBenefits | |||
| @NonRecurringExpenses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-recurring expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.NonRecurringExpenses | |||
| @Salary | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Salary amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.Salary | |||
| @SuperannuationExcess | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Excess superannuation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeRecent.Addback.SuperannuationExcess | |||
| BusinessIncomeYearToDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Details of the current year to date share of the gross (pre-tax) income or income-related amounts, attributable to this applicant | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate | |||
| @EndDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The end date for the stated income, generally the end of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.EndDate | |||
| @StartDate | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. The start date for the stated income, generally the start of a financial year | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.StartDate | Yes | Mandatory if Employment type is Self Employed and Profit Before Tax is "Year to Date" | |
| @ProfitBeforeTax | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Captures the net profit/profit before tax for the specified financial year | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.ProfitBeforeTax | Yes | Mandatory if Employment type is Self Employed and based on the income year type enum at least 1 should be mandatory for Profit Before Tax field | |
| @x_Accountant | string | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.x_Accountant | ||||
| Addback | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Container element for Year To Date Business Income Addback | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback | |||
| @Allowances | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Allowances amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.Allowances | |||
| @AmortisationOfGoodwill | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Amortisation Of Goodwill amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.AmortisationOfGoodwill | |||
| @Bonus | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Bonus amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.Bonus | |||
| @CarExpense | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Car expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.CarExpense | |||
| @CarryForwardLosses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Carry Forward Losses amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.CarryForwardLosses | |||
| @Depreciation | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Depreciation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.Depreciation | |||
| @HomeOffice | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Home Office amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.HomeOffice | |||
| @Interest | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Interest amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.Interest | |||
| @Lease | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Lease amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.Lease | |||
| @NonCashBenefits | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-cash benefits amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.NonCashBenefits | |||
| @NonRecurringExpenses | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Non-recurring expense amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.NonRecurringExpenses | |||
| @Salary | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Salary amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.Salary | |||
| @SuperannuationExcess | This item is now deprecated and will be deleted in a future release. BusinessIncome element must be used instead. Excess superannuation amount that can be an addback to the income | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.BusinessIncomeYearToDate.Addback.SuperannuationExcess | |||
| DeclaredIncome | The amount of income declared by the person applicant for Lo Doc applications | object | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.DeclaredIncome | |||
| @EndDate | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.DeclaredIncome.EndDate | ||||
| @StartDate | date | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.DeclaredIncome.StartDate | ||||
| @ProfitBeforeTax | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.DeclaredIncome.ProfitBeforeTax | ||||
| @x_Accountant | string | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.DeclaredIncome.x_Accountant | ||||
| @IncomeAmount | The gross income amount declared by the applicant | number | Package.Content.Application.PersonApplicant.Employment.SelfEmployed.DeclaredIncome.IncomeAmount | |||
| NotEmployed | Where the applicant is unemployed, the details should be submitted, if relevant to this instance of employment | object | Package.Content.Application.PersonApplicant.Employment.NotEmployed | |||
| Income | Income details for this period without employment | object | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income | |||
| @OtherIncomeAmount | Captures a gross income amount received by the applicant, that is not captured elsewhere | number | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.OtherIncomeAmount | |||
| @OtherIncomeDescription | A description of the other income | string | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.OtherIncomeDescription | |||
| @OtherIncomeFrequency | Captures the frequency at which the applicant is receiving other income gross amount | string | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.OtherIncomeFrequency | |||
| @JobseekerSupportAmount | Captures the gross Jobseeker Support income amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.JobseekerSupportAmount | |||
| @JobseekerSupportFrequency | Captures the frequency at which the applicant is receiving Jobseeker Support income gross amount | string | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.JobseekerSupportFrequency | |||
| @PrivatePensionAmount | Captures the gross pension income amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.PrivatePensionAmount | |||
| @PrivatePensionFrequency | Captures the frequency at which the applicant is receiving private pension income gross amount | string | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.PrivatePensionFrequency | |||
| @SuperannuationAmount | Captures the gross superannuation amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.SuperannuationAmount | |||
| @SuperannuationFrequency | Captures the frequency at which the applicant is receiving superannuation income gross amount | string | Package.Content.Application.PersonApplicant.Employment.NotEmployed.Income.SuperannuationFrequency | |||
| PAYE | Wrapper to contain details regarding PAYE employment | object | Package.Content.Application.PersonApplicant.Employment.PAYE | |||
| Income | Details of the income or income-related amounts | object | Package.Content.Application.PersonApplicant.Employment.PAYE.Income | |||
| @GrossRegularOvertimeAmount | The gross regular overtime income amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.GrossRegularOvertimeAmount | Any 1 is mandatory | ||
| @GrossRegularOvertimeFrequency | The frequency of the gross regular overtime income payment | string | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.GrossRegularOvertimeFrequency | Any 1 is mandatory | ||
| @GrossSalaryAmount | The gross salary income amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.GrossSalaryAmount | Any 1 is mandatory | ||
| @GrossSalaryFrequency | The frequency of the gross salary income payment | string | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.GrossSalaryFrequency | Any 1 is mandatory | ||
| @BonusAmount | The gross bonus income amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.BonusAmount | Any 1 is mandatory | ||
| @BonusFrequency | The frequency of the gross bonus income payment | string | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.BonusFrequency | Any 1 is mandatory | ||
| @CommissionAmount | The gross commission income amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.CommissionAmount | Any 1 is mandatory | ||
| @CommissionFrequency | The frequency of the gross commission income payment | string | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.CommissionFrequency | Any 1 is mandatory | ||
| @CarAllowanceAmount | The gross car allowance amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.CarAllowanceAmount | Any 1 is mandatory | ||
| @CarAllowanceFrequency | The frequency of the gross car allowance income payment | string | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.CarAllowanceFrequency | Any 1 is mandatory | ||
| @WorkAllowanceAmount | The gross work allowance amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.WorkAllowanceAmount | Any 1 is mandatory | ||
| @WorkAllowanceFrequency | The frequency of the gross work allowance income payment | string | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.WorkAllowanceFrequency | Any 1 is mandatory | ||
| @WorkersCompensationAmount | The gross workers compensation income amount received by the applicant | number | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.WorkersCompensationAmount | Any 1 is mandatory | ||
| @WorkersCompensationFrequency | The frequency of the gross workers compensation income payment | string | Package.Content.Application.PersonApplicant.Employment.PAYE.Income.WorkersCompensationFrequency | Any 1 is mandatory |
|PayG||object|Package.Content.Application.PersonApplicant.Employment.PayG||||
|Income||object|Package.Content.Application.PersonApplicant.Employment.PayG.Income||||
|@GrossRegularOvertimeAmount||number|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.GrossRegularOvertimeAmount|||PayG is not used in NZ|
|@GrossRegularOvertimeFrequency||string|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.GrossRegularOvertimeFrequency|||PayG is not used in NZ|
|@GrossSalaryAmount||number|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.GrossSalaryAmount|||PayG is not used in NZ|
|@GrossSalaryFrequency||string|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.GrossSalaryFrequency|||PayG is not used in NZ|
|@BonusAmount||number|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.BonusAmount|||PayG is not used in NZ|
|@BonusFrequency||string|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.BonusFrequency|||PayG is not used in NZ|
|@CommissionAmount||number|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.CommissionAmount|||PayG is not used in NZ|
|@CommissionFrequency||string|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.CommissionFrequency|||PayG is not used in NZ|
|@CarAllowanceAmount||number|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.CarAllowanceAmount|||PayG is not used in NZ|
|@CarAllowanceFrequency||string|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.CarAllowanceFrequency|||PayG is not used in NZ|
|@WorkAllowanceAmount||number|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.WorkAllowanceAmount|||PayG is not used in NZ|
|@WorkAllowanceFrequency||string|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.WorkAllowanceFrequency|||PayG is not used in NZ|
|@WorkersCompensationAmount||number|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.WorkersCompensationAmount|||PayG is not used in NZ|
|@WorkersCompensationFrequency||string|Package.Content.Application.PersonApplicant.Employment.PAYG.Income.WorkersCompensationFrequency|||PayG is not used in NZ|